Paid API一覧
HTTP仕様（.idPass）
| Request header |
Content-Type: application/x-www-form-urlencoded;charset=windows-31j |
|
|---|---|---|
| Method |
POST |
|
| Response header |
Content-Type: text/plain;charset=windows-31j |
|
| Status Code |
200：常に200を返却 |
|
SavePaidBuyer 取引先登録
指定された取引先情報をPaidに登録します。登録後、Paidにおいて審査が行われます。Paidから取引先にメールや電話で連絡をする場合があります。
審査が完了するとPaidで取引ができるようになります。取引先がすでにPaid会員であっても、加盟店様（Paidアカウント）ごとに審査が必要となります。
※審査には通常1～3営業日掛かります。
加盟店様サイトの会員新規登録時に登録するか、加盟店様サイトの既存会員情報を元にPaidの取引先登録をする想定です。
加盟店様サイトの会員登録時は、Paidの取引先登録必須項目をご準備ください。
※取引登録時には以下のページ内のPaid利用規約をご案内ください。
https://paid.jp/
リクエスト
| ShopID | 必須 半角英数13桁
ショップID
|
|
|---|---|---|
| ShopPass | 必須 半角英数64桁
ショップパスワード
|
|
| PaidBuyerID | 必須 半角英数記号20桁
Paid取引先ID |
|
| CompanyName | 必須 全半角50バイト
会社名個人事業主の場合は屋号・店舗等をご入力ください。 |
|
| CompanyNameKana | 必須 全半角カナ50バイト
会社名カナ
|
|
| RepresentativeSei | 必須 全半角50バイト
代表者姓
|
|
| RepresentativeMei | 必須 全半角50バイト
代表者名
|
|
| RepresentativeSeiKana | 必須 全半角カナ50バイト
代表者姓カナ
|
|
| RepresentativeMeiKana | 必須 全半角カナ50バイト
代表社名カナ
|
|
| ZipCode | 必須 半角数字記号8桁
郵便番号999-9999形式 |
|
| Prefecture | 必須 全半角5バイト
都道府県
|
|
| Address1 | 必須 全半角50バイト
市区町村
|
|
| Address2 | 必須 全半角50バイト
町名・番地
|
|
| Address3 | 全半角50バイト
ビル・マンション名
|
|
| AuxName | 全半角50バイト
部署名 / 支店名
|
|
| ClerkSei | 必須 全半角50バイト
担当者姓
|
|
| ClerkMei | 必須 全半角50バイト
担当者名
|
|
| ClerkSeiKana | 必須 全半角カナ50バイト
担当者姓カナ
|
|
| ClerkMeiKana | 必須 全半角カナ50バイト
担当者名カナ
|
|
| Tel | 必須 半角数字記号25桁
電話番号市外局番からハイフンを入れて入力 |
|
| Fax | 半角数字記号25桁
FAX番号市外局番からハイフンを入れて入力 |
|
| MobileTel | 半角数字記号25桁
携帯電話番号999-9999-9999形式 |
|
必須 半角英数記号100桁
メールアドレス
|
||
| ClosingDay | 半角数字2桁
締め日 20：20日締め |
|
| PaymentMethod | 半角数字1桁 固定
支払方法 1：銀行振り込み |
|
/payment/SavePaidBuyer.idPassShopID=tshop11223344&ShopPass=PASSWORD&PaidBuyerID=123456789&CompanyName=会社名&CompanyNameKana=カナ&RepresentativeSei=代表者性&RepresentativeMei=代表者名&RepresentativeSeiKana=カナ&RepresentativeMeiKana=カナ&ZipCode=123-4567&Prefecture=東京都&Address1=渋谷区&Address2=道玄坂&ClerkSei=担当者姓&ClerkMei=担当者名&ClerkSeiKana=カナ&ClerkMeiKana=カナ&Tel=12-3456-7890&Email=sample@sample.co.jpCheckPaidBuyer 取引先ステータス確認
取引先の審査状態を確認します。
CheckPaidRestAmount 取引先利用可能額確認
取引先の利用可能額を確認します。
EntryTranPaid 取引登録
これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。
ExecTranPaid 決済実行
指定した決済内容でPaidに限度額の確認を行い、結果を返します。
処理完了後にPaidに受注登録しますので、ご利用状況によりご注文がキャンセル（決済失敗）される場合があります。
※決済結果は結果通知、または管理画面で確認することができます。
※Paidでは受注登録の翌日を起算日として180日経過すると、取引が自動キャンセルされます。
リクエスト
| ShopID | 必須 半角英数13桁
ショップID
|
|
|---|---|---|
| ShopPass | 必須 半角英数64桁
ショップパスワード
|
|
| AccessID | 必須 半角英数32桁 固定
取引ID
|
|
| AccessPass | 必須 半角英数32桁 固定
取引パスワード
|
|
| OrderID | 必須 半角英数記号27桁
オーダーID
|
|
| PaidBuyerID | 必須 半角英数記号20桁
Paid取引先ID |
|
| Contents | 全半角80バイト
注文内容 Paidの「注文内容」を設定します。 |
|
| ClientField1 | 全半角100バイト
加盟店自由項目1
|
|
| ClientField2 | 全半角100バイト
加盟店自由項目2
|
|
| ClientField3 | 全半角100バイト
加盟店自由項目3
|
|
| ClientFieldFlag | 半角数字1桁 固定
加盟店自由項目返却フラグ 以下のいずれかを設定します。 |
|
/payment/ExecTranPaid.idPassShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&PaidBuyerID=123456789レスポンス
OrderID=ORDER0000001&Status=REQSUCCESS&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3ErrCode=E01&ErrInfo=E01040001PaidChange 金額変更
仮売上の取引に対して金額の変更を行います。
リクエスト
| ShopID | 必須 半角英数13桁
ショップID
|
|
|---|---|---|
| ShopPass | 必須 半角英数64桁
ショップパスワード
|
|
| AccessID | 必須 半角英数32桁 固定
取引ID
|
|
| AccessPass | 必須 半角英数32桁 固定
取引パスワード
|
|
| OrderID | 必須 半角英数記号27桁
オーダーID
|
|
| Amount | 必須 半角数字10桁
利用金額 変更後の利用金額を設定します。 |
|
| Tax | 半角数字10桁
税送料
|
|
/payment/PaidChange.idPassShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=100PaidCancel キャンセル
仮売上の取引に対して決済内容のキャンセルを行います。
リクエスト
| ShopID | 必須 半角英数13桁
ショップID
|
|
|---|---|---|
| ShopPass | 必須 半角英数64桁
ショップパスワード
|
|
| AccessID | 必須 半角英数32桁 固定
取引ID
|
|
| AccessPass | 必須 半角英数32桁 固定
取引パスワード
|
|
| OrderID | 必須 半角英数記号27桁
オーダーID
|
|
/payment/PaidCancel.idPassShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001PaidSales 実売上
仮売上の取引に対して実売上を行います。
リクエスト
| ShopID | 必須 半角英数13桁
ショップID
|
|
|---|---|---|
| ShopPass | 必須 半角英数64桁
ショップパスワード
|
|
| AccessID | 必須 半角英数32桁 固定
取引ID
|
|
| AccessPass | 必須 半角英数32桁 固定
取引パスワード
|
|
| OrderID | 必須 半角英数記号27桁
オーダーID
|
|
| FixedAt | 半角数字8桁
決済確定日 （本パラメータを利用するには設定が必要なため弊社にご連絡ください。） |
|
/payment/PaidSales.idPassShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001PaidReturn 返品
決済が完了した取引に対して返品を行います。
※実売上後、180日以上経過すると返品できません。
リクエスト
| ShopID | 必須 半角英数13桁
ショップID
|
|
|---|---|---|
| ShopPass | 必須 半角英数64桁
ショップパスワード
|
|
| AccessID | 必須 半角英数32桁 固定
取引ID
|
|
| AccessPass | 必須 半角英数32桁 固定
取引パスワード
|
|
| OrderID | 必須 半角英数記号27桁
オーダーID
|
|
/payment/PaidReturn.idPassShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001SearchTradeMulti 取引状態参照
指定したオーダーIDの取引情報を取得します。
レスポンス
正常
| Status |
現状態 UNPROCESSED：未決済 |
|
|---|---|---|
| ProcessDate | 半角数字14桁 固定
処理日時yyyyMMddHHmmss形式 |
|
| JobCd |
処理区分 AUTH：仮売上 |
|
| AccessID | 半角英数32桁 固定
取引ID
|
|
| AccessPass | 半角英数32桁 固定
取引パスワード
|
|
| Amount | 半角数字10桁
利用金額
|
|
| Tax | 半角数字10桁
税送料
|
|
| ClientField1 | 全半角100バイト
加盟店自由項目1
|
|
| ClientField2 | 全半角100バイト
加盟店自由項目2
|
|
| ClientField3 | 全半角100バイト
加盟店自由項目3
|
|
| PayType | 半角数字2桁
決済方法29：Paid決済 |
|
| PaidCancelAmount | 半角数字10桁
Paidキャンセル金額
|
|
| PaidCancelTax | 半角数字10桁
Paidキャンセル税送料
|
|
| PaidBuyerID | 半角英数記号20桁
Paid取引先ID
|
|
| PaidCode | 半角英数記号27桁
Paid伝票番号Paid決済時に当サービスで発行する伝票番号です。 |
|
| PaidContents | 全半角160バイト
Paid注文内容
|
|
Status=AUTH&ProcessDate=20220801121212&JobCd=AUTH&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=100&Tax=0&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=29&ErrCode=&ErrInfo=&PaidCancelAmount=50&PaidCancelTax=0&PaidBuyerID=123456789&PaidCode=ORDER0000001&PaidContents=注文内容ErrCode=E01&ErrInfo=E01040001